FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package hl7.fhir.us.davinci-pr#current (16 ms)

Package hl7.fhir.us.davinci-pr
Type OperationDefinition
Id Id
FHIR Version R4
Source http://hl7.org/fhir/us/davinci-pr/https://build.fhir.org/ig/HL7/davinci-pr/OperationDefinition-DownloadRemittance.html
Url http://hl7.org/fhir/us/davinci-pr/OperationDefinition/DownloadRemittance
Version 1.0.0-ballot
Status active
Date 2024-12-16T14:03:45+00:00
Name DownloadRemittance
Title Download Postable Remittance
Experimental False
Realm us
Authority hl7
Description This operation is used to download a previously sent postable remittance.
Type false
Kind operation

Resources that use this resource

CapabilityStatement
PostableRemittanceClientCapabilities Postable Remittance Client Capabilities
PostableRemittanceServerCapabilities Postable Remittance Server Capabilities

Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition DownloadRemittance

URL: [base]/$downloadRemittance

Input parameters Profile:Download Remittance Incoming Parameters

Output parameters Profile:Remittance Advice Document

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INRemittanceAdviceIdentifier1..1string

Remittance Advice Identifier

INRemittanceAdviceType0..1codeRemittance Advice Value Set (Required)

Advice on which file format to be returned.

OUTRemittanceAdviceDocument1..1Binary (Remittance Advice Document)

Remittance Advice file sent as a binary and compressed in a zip format.


Source

{
  "resourceType" : "OperationDefinition",
  "id" : "DownloadRemittance",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition DownloadRemittance</b></p><a name=\"DownloadRemittance\"> </a><a name=\"hcDownloadRemittance\"> </a><a name=\"DownloadRemittance-en-US\"> </a><p>URL: [base]/$downloadRemittance</p><p>Input parameters Profile:<a href=\"StructureDefinition-downloadRemittanceParameters.html\">Download Remittance Incoming Parameters</a></p><p>Output parameters Profile:<a href=\"StructureDefinition-remittanceAdviceDocument.html\">Remittance Advice Document</a></p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>RemittanceAdviceIdentifier</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Remittance Advice Identifier</p>\n</div></td></tr><tr><td>IN</td><td>RemittanceAdviceType</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-RemittanceAdviceType.html\">Remittance Advice Value Set</a> (Required)</td><td><div><p>Advice on which file format to be returned.</p>\n</div></td></tr><tr><td>OUT</td><td>RemittanceAdviceDocument</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a> (<a href=\"StructureDefinition-remittanceAdviceDocument.html\" title=\"http://hl7.org/fhir/us/davinci-pr/StructureDefinition/remittanceAdviceDocument\">Remittance Advice Document</a>)</td><td/><td><div><p>Remittance Advice file sent as a binary and compressed in a zip format.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "claims"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 1,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/davinci-pr/OperationDefinition/DownloadRemittance",
  "version" : "1.0.0-ballot",
  "name" : "DownloadRemittance",
  "title" : "Download Postable Remittance",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-12-16T14:03:45+00:00",
  "publisher" : "HL7 International / Payer/Provider Information Exchange Work Group",
  "contact" : [
    {
      "name" : "HL7 International / Payer/Provider Information Exchange Work Group",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/claims"
        }
      ]
    }
  ],
  "description" : "This operation is used to download a previously sent postable remittance.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "code" : "downloadRemittance",
  "system" : true,
  "type" : false,
  "instance" : false,
  "inputProfile" : "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/downloadRemittanceParameters",
  "outputProfile" : "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/remittanceAdviceDocument",
  "parameter" : [
    {
      "name" : "RemittanceAdviceIdentifier",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Remittance Advice Identifier",
      "type" : "string"
    },
    {
      "name" : "RemittanceAdviceType",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Advice on which file format to be returned.",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType"
      }
    },
    {
      "name" : "RemittanceAdviceDocument",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Remittance Advice file sent as a binary and compressed in a zip format.",
      "type" : "Binary",
      "targetProfile" : [
        "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/remittanceAdviceDocument"
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.